Skip to content

docs: document is_configured_realtime for graph construction - #788

Closed
pengpengyi92 wants to merge 1 commit into
Point72:mainfrom
pengpengyi92:codex/document-configured-realtime
Closed

pengpengyi92 wants to merge 1 commit into
Point72:mainfrom
pengpengyi92:codex/document-configured-realtime

Conversation

@pengpengyi92

Copy link
Copy Markdown

Summary

Fixes #395.

Document csp.is_configured_realtime() in the Graph Utilities API reference:

  • explain its configured-mode flag, default, graph-building context, and out-of-context error;
  • show how it can select historical versus live input adapters;
  • distinguish it from the node-body csp.in_realtime() builtin, including historical replay in a realtime-configured run;
  • include an executable, zero-duration example using constants instead of external adapters.

Scope: one documentation file. No runtime, adapter, dependency, or API behavior changes. This does not modify Execution Modes or duplicate the replay examples in #740 / #761.

Validation

  • Executed the exact new Markdown example for both configured modes.
  • Local helper-contract checks: 9 passed (run, build_graph, threaded run, context cleanup, nested context, historical-phase distinction, import provenance, and example execution).
  • Existing tests: python -m pytest csp/tests/impl/wiring csp/tests/test_engine.py::TestEngine::test_realtime_flag -q -> 22 passed, 2 skipped, before and after the documentation change.
  • python -m mdformat --check docs/wiki/api-references/Graph-Utilities-API.md -> passed.
  • python -m codespell_lib docs/wiki/api-references/Graph-Utilities-API.md -> passed.
  • git diff --check -> passed.

Environment: Windows, Python 3.12.14, local CSP Python source with official CSP 0.19.1 Windows wheel native libraries. No C++ rebuild or Linux/macOS matrix was run. The extra helper-contract checks are local verification, not added upstream tests. Upstream CI and maintainer review are not implied by these results.

Draft for maintainer review of scope and wording; no engine behavior change is proposed.

Signed-off-by: Pengyi Peng <74917296+pengpengyi92@users.noreply.github.com>
@timkpaine

Copy link
Copy Markdown
Member

Thanks for the PR! I've consolidated some docs updates in #795

@timkpaine timkpaine closed this Nov 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation for is_configured_realtime

2 participants